前言
本系列文章是Egg学习过程的一个记录,初步目标是写一个个人博客,会尽可能多使用Egg中提供的各种功能.
本文全部使用 async
请确保Node版本足够支持.
文中有不正确地方请指正.
GitHub地址: https://github.com/devil5263/...
Egg文档: https://eggjs.org/zh-cn/intro/
初始化项目
使用Egg脚手架初始化项目
$ npm instal egg-init -g
$ egg-init egg-example --type=simple // 选择初始化项目的类型
$ cd egg-example
$ npm install
项目目录结构
egg-project
├── package.json
├── app.js //自定义启动时的初始化工作
├── app
| ├── router.js // 配置 URL 路由规则
│ ├── controller // 控制层
│ | └── auth.js // 业务逻辑-注册登录实现
│ ├── service // 业务逻辑层
│ | └── auth.js // 业务逻辑-注册登录实现
| ├── model // 数据库表结构
│ | └── user.js // 业务逻辑-user表
│ ├── middleware // 中间件
│ ├── schedule // 任务
│ └── extend // 框架的扩展
├── config // 初始化-所有配置文件
| ├── plugin.js
| ├── config.default.js
│ ├── config.prod.js
| ├── config.test.js (可选)
| ├── config.local.js (可选)
| └── config.unittest.js (可选)
├── build // 前端webpack打包配置
| ├── webpack.base.js
| ├── webpack.dev.js
| └── webpack.prod.js
├── resource// 前端源文件
| ├── assets // 前端资源
| ├── components // 前端组件
│ └── pages // 前端页面
| └── page1 // 某一页面
| ├── app.vue // vue单文件组件
| ├── index.js // vue入口文件
| ├── index.html // html页面
| └── js (可选) // store/router js文件
└── test // 初始化-单元测试用例
├── middleware
| └── response_time.test.js
└── controller
└── home.test.js
MySQL配置
这里使用了两个Egg的插件
-
egg-mysql
用于连接MySQL(需要npm install egg-mysql
) -
egg-sequelize
用于定义model进行db层操作(需要安装egg-sequelize
和mysql2
两个库)
数据库配置
// {work_dir}/config/config.default.js
const database = "egg"; // 数据库名字
module.exports = appInfo => {
const config = {};
config.keys = appInfo.name + "_1501817502166_7037";
config.sequelize = { // egg-sequelize 配置
dialect: "mysql", // db type
database: database,
host: "localhost",
port: "3306",
username: "root",
password: ""
};
return config;
};
插件配置
// {work_dir}/config/plugin.js
exports.sequelize = {
enable: true,
package: "egg-sequelize"
};
启动时创建数据库表
// {work_dir}/app.js
module.exports = app => {
app.beforeStart(async function () {
await app.model.sync({ force: true });
});
};
定义model
// {work_dir}/app/model/user.js
module.exports = app => {
const { STRING, INTEGER, DATE } = app.Sequelize;
const User = app.model.define("user", {
login: STRING,
id: {
type: INTEGER,
primaryKey: true,
autoIncrement: true
},
name: STRING(30),
password: STRING(32),
age: INTEGER,
last_sign_in_at: DATE,
created_at: DATE,
updated_at: DATE
});
return User;
};
目前为止,egg-example项目已初始化并添加了MySQL配置,成功启动后会发现数据库中已经有了定义的 model User
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。